<meta charset="utf-8">
(#) Should not call `TextView.setCompoundDrawableTintList` or `TextView.setCompoundDrawableTintMode` directly

!!! WARNING: Should not call `TextView.setCompoundDrawableTintList` or `TextView.setCompoundDrawableTintMode` directly
   This is a warning.

Id
:   `UseCompatTextViewDrawableApis`
Summary
:   Should not call `TextView.setCompoundDrawableTintList` or `TextView.setCompoundDrawableTintMode` directly
Severity
:   Warning
Category
:   Correctness
Platform
:   Any
Vendor
:   Android Open Source Project
Identifier
:   androidx.appcompat
Feedback
:   https://issuetracker.google.com/issues/new?component=460343
Min
:   Lint 7.0
Compiled
:   Lint 8.0 and 8.1
Artifact
:   [androidx.appcompat:appcompat](androidx_appcompat_appcompat.md.html)
Since
:   1.2.0
Affects
:   Kotlin and Java files
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/appcompat/appcompat-lint/src/main/kotlin/androidx/appcompat/widget/TextViewCompoundDrawablesApiDetector.kt)
Tests
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/appcompat/appcompat-lint/src/test/kotlin/androidx/appcompat/lint/widget/TextViewCompoundDrawablesApiDetectorTest.kt)
Copyright Year
:   2020

Use Compat loading of compound text view drawables.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
com/example/CustomActivity.kt:11:Warning: Use
TextViewCompat.setCompoundDrawableTintList()
[UseCompatTextViewDrawableApis]
    textView.setCompoundDrawableTintList(csl)
    -----------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`com/example/CustomActivity.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package com.example

import android.os.Bundle
import android.widget.TextView
import androidx.appcompat.app.AppCompatActivity

class CustomActivity: AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        val textView = TextView(this)
        val csl = getResources().getColorStateList(R.color.color_state_list)
        textView.setCompoundDrawableTintList(csl)
    }
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/appcompat/appcompat-lint/src/test/kotlin/androidx/appcompat/lint/widget/TextViewCompoundDrawablesApiDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `TextViewCompoundDrawablesApiDetector.testSetCompoundDrawableTintList`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=460343.

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project.

```
// build.gradle.kts
implementation("androidx.appcompat:appcompat:1.7.0")

// build.gradle
implementation 'androidx.appcompat:appcompat:1.7.0'

// build.gradle.kts with version catalogs:
implementation(libs.appcompat)

# libs.versions.toml
[versions]
appcompat = "1.7.0"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
appcompat = {
    module = "androidx.appcompat:appcompat",
    version.ref = "appcompat"
}
```

1.7.0 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about androidx.appcompat:appcompat](androidx_appcompat_appcompat.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("UseCompatTextViewDrawableApis")
  fun method() {
     setCompoundDrawableTintList(...)
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("UseCompatTextViewDrawableApis")
  void method() {
     setCompoundDrawableTintList(...);
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection UseCompatTextViewDrawableApis
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="UseCompatTextViewDrawableApis" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'UseCompatTextViewDrawableApis'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore UseCompatTextViewDrawableApis ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>